Configuração de Webhooks
Webhooks são o método principal para receber atualizações da nossa API. Eles recebem a mais alta prioridade, garantindo que as atualizações sejam entregues a eles primeiro. Portanto, é crucial configurar corretamente seus webhooks para garantir que você receba atualizações prontamente e de forma confiável. Recomendamos que para configuração do webhook no ambiente de homologação, que não seja usada uma das chaves de API públicas, pois dificulta a configuração uma vez que qualquer usuário pode usa-las
Webhooks configuration
Requisição
POST 'https://apisandbox.delbank.com.br/baas/api/v1/webhooks'
Headers
| Nome | Descrição |
|---|---|
| x-delbank-api-key | Obrigatório. Chave de API |
Corpo da requisição
| Nome | Tipo | Descrição |
|---|---|---|
| eventType | enum | Obrigatório. Tipo de evento a ser monitorado/ouvido |
| url | string | Obrigatório. URL da API do sistema cliente que irá receber as informações do webhook |
| authorizationScheme | enum | Tipo de autorização que deve ser utilizado durante a execução da chamada do endpoint (conforme o campo url). Domínios:Domains: - BASIC- BEARER- HEADER |
| authorization | string | Information that will be sent in the request header to the endpoint |
Exemplo básico
Configurando Webhook com Authentication Basic
{
"eventType": "PIX_RECEIVED",
"url": "https://example.com.br/webhooks/v1/bankslips",
"authorization": "bG9naW46cGFzc3dvcmQ=",
"authorizationScheme": "BASIC"
}
Configurando Webhook com Authentication Bearer
{
"eventType": "PIX_RECEIVED",
"url": "https://example.com.br/webhooks/v1/bankslips",
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"authorizationScheme": "BEARER"
}
Configurando Webhook com Authentication customizada
{
"eventType": "PIX_RECEIVED",
"url": "https://example.com.br/webhooks/v1/bankslips",
"authorization": "x-webhook-key: yourKey",
"authorizationScheme": "HEADER"
}
Manutenção das configurações
| Endpoint | HTTP Method | Description |
|---|---|---|
| https://apisandbox.delbank.com.br/baas/api/v1/webhooks | GET | Busca todos os webhook cadastrados da chave de API usada na requisição. |
| https://apisandbox.delbank.com.br/baas/api/v1/webhooks/:ID | GET | Buscar webhook por ID |
| https://apisandbox.delbank.com.br/baas/api/v1/webhooks/:ID | PATCH | Atualização do webhook por ID (utilizar o mesmo payload do cadastro de webhook) |
| https://apisandbox.delbank.com.br/baas/api/v1/webhooks/:ID | DELETE | Remoção do Webhook por ID |
Tipos de Eventos
A seguir, uma relação entre os tipos de evento e seu significado.
| Nome | Descrição | Link |
|---|---|---|
| CHARGE_PAID | Boleto Bancário pago. | Click here |
| PIX_RECEIVED | Pix recebido. | Click here |
| PIX_PAYMENT_UPDATED | Atualização de situação de Pagamento Pix | Click here |
| PIX_REFUNDED | Evento para reembolsos recebidos | Click here |
| PIX_REFUND_PAYMENT_UPDATED | Evento para reembolsos enviados | Click here |
| TRANSFER_INTERNAL_CREDITED | Evento para transferência interna recebida | Click here |
| TRANSFER_INTERNAL_DEBITED | Evento para transferência interna enviada | Click here |
| WHITELABEL_CUSTOMER_DOCUMENTATION_REJECTED | Documentos rejeitados para uma nova conta criada | Click here |
| WHITELABEL_CUSTOMER_APPROVED | Cliente aprovado e conta bancária criada | Click here |